READ.me update #104
READ.me update #104
Conversation
readme updated with workflow directory
This PR is against the
|
| **nf-core/seqinspector** - | ||
| <p align="justify"><br>a basic QC pipeline for sequencing core facilities providing high quality data from a range of different sequencing instruments to their users is in the interest of every sequencing facility. In order to monitor their sequencing quality, performing standardized, yet flexible quality controls for every sequencing project and sample that passes through their facilities is crucial to ensure consistent quality and dependable results.</br> | ||
| <br>The Nextflow pipeline nf-core/seqinspector is envisioned as a unified quality control pipeline for sequencing data originating from instruments of various providers like Illumina, Oxford Nanopore Technologies or Pacific Biosciences.</br> | ||
| <br>It will assess sequencing quality, duplication levels and complexity on a per-sample basis, in addition to highlighting adapter contents and technical artifacts. Furthermore, it will facilitate the detection of common biological contaminants that may have been introduced to the samples before or during library preparation.</br> | ||
| <br>Since facilities share their flowcells and even sequencing lanes between different projects, the report generation will be particularly versatile and customizable. Quality reports can be obtained with a variable granularity ranging from individual samples or projects to whole flow cells. Therefore, receiving one single MultiQC report that summarizes all input samples, or having individual MultiQC reports for sample groups determined by the sample sheet will be possible.</br> | ||
| <br>While nf-core/seqinspector is developed by and for core facilities, it will also be a useful QC solution for research groups that own or have access to a sequencer outside of facilities. This project is still under development, and we are happy to welcome collaborators.</br></p> | ||
|
|
||
| <h1> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="docs/images/seqinspector_poster_2024_v4.png"> | ||
| <img src="docs/images/seqinspector_poster_2024_v4.png"> | ||
| </picture> | ||
| </h1> |
There was a problem hiding this comment.
Thanks for working on improving the readme :)
In the todo on line 37 below, it says this description should only be 2-3 sentences long, could you maybe summarize your text so that it fits this constraint?
Also I'm not sure the poster belongs here, you could reuse the figure, but then you should adapt it so that it fits this readme.
There was a problem hiding this comment.
hej @GustavoYnada, thanks for starting this! You have currently 2 PRs open, is #101 a duplicate of this one? Do we need both?
There was a problem hiding this comment.
Ah yes, I just reviewed #101 , but it is definitely a duplicate. I will close that one.
There was a problem hiding this comment.
Like I wrote in that review, I think it would make sense to use the tube map as illustration of the pipeline #85
|
I think we might wanna close this in favor of #111 |
4 participants
PR checklist
nf-core lint).nf-test test main.nf.test -profile test,docker).nextflow run . -profile debug,test,docker --outdir <OUTDIR>).docs/usage.mdis updated.docs/output.mdis updated.CHANGELOG.mdis updated.README.mdis updated (including new tool citations and authors/contributors).